Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to use the metalk8s-utils image #2995

Merged
merged 4 commits into from
Jan 15, 2021
Merged

Document how to use the metalk8s-utils image #2995

merged 4 commits into from
Jan 15, 2021

Conversation

NicolasT
Copy link
Contributor

We ship a container image with a bunch of utilities that are very useful to troubleshoot a MetalK8s cluster (or Kubernetes cluster in general), but don't really document this.

This is a first shot at describing how to use the image.

@NicolasT NicolasT added the topic:docs Documentation label Dec 21, 2020
@NicolasT NicolasT requested a review from a team as a code owner December 21, 2020 16:47
@bert-e
Copy link
Contributor

bert-e commented Dec 21, 2020

Hello nicolast,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

@bert-e
Copy link
Contributor

bert-e commented Dec 21, 2020

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

@NicolasT NicolasT force-pushed the improvement/doc-metalk8s-utils branch 2 times, most recently from f84888b to eef6b73 Compare December 21, 2020 18:03
lucieleonard
lucieleonard reviewed Dec 22, 2020
View reviewed changes
docs/operation/metalk8s-utils.rst Outdated
To detach, simply exit the shell. Note the :program:`screen` and
:program:`tmux` utilities are installed in the image for terminal multiplexing.

Finally, when the container is no longer needed, remove the *Pod* using
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

#. When the container... remove the Pod using...

thomasdanan
thomasdanan previously approved these changes Jan 4, 2021
View reviewed changes
Copy link
Contributor

@thomasdanan thomasdanan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did try all the described ways to run metalk8s-util pods and all worked fine.

NicolasT added a commit that referenced this pull request Jan 8, 2021
@NicolasT
docs: first stab at documenting how to use metalk8s-utils
6a8509a 
See: #2995
@NicolasT NicolasT force-pushed the improvement/doc-metalk8s-utils branch from eef6b73 to 6a8509a Compare January 8, 2021 17:19
@bert-e
Copy link
Contributor

bert-e commented Jan 8, 2021

Branches have diverged

This pull request's source branch improvement/doc-metalk8s-utils has diverged from
development/2.7 by more than 50 commits.

To avoid any integration risks, please re-synchronize them using one of the
following solutions:

  • Merge origin/development/2.7 into improvement/doc-metalk8s-utils
  • Rebase improvement/doc-metalk8s-utils onto origin/development/2.7

Note: If you choose to rebase, you may have to ask me to rebuild
integration branches using the reset command.

NicolasT added a commit that referenced this pull request Jan 8, 2021
@NicolasT
docs: first stab at documenting how to use metalk8s-utils
79dcbbd 
See: #2995
@NicolasT NicolasT force-pushed the improvement/doc-metalk8s-utils branch from 6a8509a to 79dcbbd Compare January 8, 2021 17:22
@NicolasT NicolasT requested a review from lucieleonard January 8, 2021 17:23
@NicolasT
Copy link
Contributor Author

NicolasT commented Jan 8, 2021

/reset

@bert-e
Copy link
Contributor

bert-e commented Jan 8, 2021

Reset complete

I have successfully deleted this pull request's integration branches.

@bert-e
Copy link
Contributor

bert-e commented Jan 8, 2021

Branches have diverged

This pull request's source branch improvement/doc-metalk8s-utils has diverged from
development/2.7 by more than 50 commits.

To avoid any integration risks, please re-synchronize them using one of the
following solutions:

  • Merge origin/development/2.7 into improvement/doc-metalk8s-utils
  • Rebase improvement/doc-metalk8s-utils onto origin/development/2.7

Note: If you choose to rebase, you may have to ask me to rebuild
integration branches using the reset command.

@NicolasT
images: install screen and tmux in metalk8s-utils
e5a1a54 
Can be useful in long-running troubleshooting sessions...
@NicolasT
docs: fix SPHINXOPTS handling
517c890 
The `SPHINXOPTS` value was not actually taken from the environment by
the `Makefile`, hence the value set in `tox.ini` wasn't really being
used at all.

Instead, hard-code some basic `SPHINXOPTS` in the `Makefile` (and
`make.bat`), ensure `O` is actually passed on through an environment
variable, and set a value we actually want to (only) set when running
the `docs` Tox target (`-W`, treating warnings as errors) using it.
@NicolasT
images: create kubectl bash-completion in metalk8s-utils
a33a19e 
The `kubectl` package we install in the `metalk8s-utils` image doesn't
come with `bash-completion` scripts (unlike `kubernetes-client` on
Fedora). Since this is useful to have, we now generate the completions
as part of the image build process.
@NicolasT
docs: first stab at documenting how to use metalk8s-utils
d6935d8 
See: #2995
@NicolasT NicolasT force-pushed the improvement/doc-metalk8s-utils branch from 79dcbbd to d6935d8 Compare January 8, 2021 17:27
@NicolasT
Copy link
Contributor Author

NicolasT commented Jan 8, 2021

/reset

@bert-e
Copy link
Contributor

bert-e commented Jan 8, 2021

Integration data created

I have created the integration data for the additional destination branches.

The following branches will NOT be impacted:

  • development/1.0
  • development/1.1
  • development/1.2
  • development/1.3
  • development/2.0
  • development/2.1
  • development/2.2
  • development/2.3
  • development/2.4
  • development/2.5
  • development/2.6

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

@bert-e
Copy link
Contributor

bert-e commented Jan 8, 2021

Waiting for approval

The following approvals are needed before I can proceed with the merge:

  • the author

  • one peer

Peer approvals must include at least 1 approval from the following list:

gdemonet
gdemonet approved these changes Jan 14, 2021
View reviewed changes
docs/operation/metalk8s-utils.rst
PID namespace, elevated privileges, mounting host directories as volumes, etc.

See the ``metalk8s-utils``
:download:`Dockerfile <../../images/metalk8s-utils/Dockerfile>` for a list of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh neat, didn't realize we could embed files for download 👍

docs/operation/metalk8s-utils.rst
Comment on lines +101 to +105
- Adding tolerations for various taints when using `nodeName`
- Mounting a host directory
- Exposing Salt and containerd sockets
- Running a privileged container, exposing the host `/dev` in the container
for `parted` etc. to work
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a future improvement, we could add example manifests in the ISO for each use case, and let our users kubectl apply them. Maybe using kustomize in the mix can help as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was considering that as well. Someday ;-)

@NicolasT
Copy link
Contributor Author

/approve

@bert-e
Copy link
Contributor

bert-e commented Jan 14, 2021

Build failed

The build for commit did not succeed in branch w/2.8/improvement/doc-metalk8s-utils.

The following options are set: approve

@NicolasT
Copy link
Contributor Author

@bert-e status

@bert-e
Copy link
Contributor

bert-e commented Jan 14, 2021

Status

Status report is not available.

The following options are set: approve

@bert-e
Copy link
Contributor

bert-e commented Jan 14, 2021

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

  • ✔️ development/2.7

  • ✔️ development/2.8

The following branches will NOT be impacted:

  • development/1.0
  • development/1.1
  • development/1.2
  • development/1.3
  • development/2.0
  • development/2.1
  • development/2.2
  • development/2.3
  • development/2.4
  • development/2.5
  • development/2.6

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

  • Any commit you add on the source branch will trigger a new cycle after the
    current queue is merged.
  • Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: approve

@bert-e
Copy link
Contributor

bert-e commented Jan 15, 2021

I have successfully merged the changeset of this pull request
into targetted development branches:

  • ✔️ development/2.7

  • ✔️ development/2.8

The following branches have NOT changed:

  • development/1.0
  • development/1.1
  • development/1.2
  • development/1.3
  • development/2.0
  • development/2.1
  • development/2.2
  • development/2.3
  • development/2.4
  • development/2.5
  • development/2.6

Please check the status of the associated issue None.

Goodbye nicolast.

@bert-e bert-e merged commit 0cb6667 into development/2.7 Jan 15, 2021
@bert-e bert-e deleted the improvement/doc-metalk8s-utils branch January 15, 2021 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gdemonet gdemonet gdemonet approved these changes

@thomasdanan thomasdanan thomasdanan left review comments

@cathydossantospinto cathydossantospinto Awaiting requested review from cathydossantospinto

@lucieleonard lucieleonard Awaiting requested review from lucieleonard

Assignees
No one assigned
Labels
topic:docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@NicolasT @bert-e @thomasdanan @lucieleonard @gdemonet